Skip to content

Update documentation#165

Merged
christopherwharrop-noaa merged 33 commits intomainfrom
feature/update-docs
Mar 7, 2026
Merged

Update documentation#165
christopherwharrop-noaa merged 33 commits intomainfrom
feature/update-docs

Conversation

@christopherwharrop-noaa
Copy link
Collaborator

@christopherwharrop-noaa christopherwharrop-noaa commented Mar 1, 2026

This updates the documentation to a complete first draft. It also updates the licensing for the repository and provides an initial Conda recipe for uploading to conda-forge. Some API changes were also made when creating the documentation exposed some problems. Closes #111

@christopherwharrop-noaa christopherwharrop-noaa changed the title Update pyproject.toml in preparation for pypi packaging Update documentation Mar 1, 2026
@github-actions
Copy link

github-actions bot commented Mar 2, 2026

📊 Test Coverage Report

Status: ⚠️ UNKNOWN (Coverage: N/A% | Threshold: 100%)

❌ Coverage report not available


Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

1 similar comment
@github-actions
Copy link

github-actions bot commented Mar 2, 2026

📊 Test Coverage Report

Status: ⚠️ UNKNOWN (Coverage: N/A% | Threshold: 100%)

❌ Coverage report not available


Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

@github-actions
Copy link

github-actions bot commented Mar 2, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

1 similar comment
@github-actions
Copy link

github-actions bot commented Mar 2, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

@github-actions
Copy link

github-actions bot commented Mar 2, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

@github-actions
Copy link

github-actions bot commented Mar 3, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

@github-actions
Copy link

github-actions bot commented Mar 3, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

@github-actions
Copy link

github-actions bot commented Mar 5, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

@github-actions
Copy link

github-actions bot commented Mar 5, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

2 similar comments
@github-actions
Copy link

github-actions bot commented Mar 5, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

@github-actions
Copy link

github-actions bot commented Mar 5, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 59 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 410 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 45 out of 45 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link

github-actions bot commented Mar 7, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 58 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 409 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 45 out of 45 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link

github-actions bot commented Mar 7, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 58 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 409 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 45 out of 45 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link

github-actions bot commented Mar 7, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 58 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 409 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 45 out of 45 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link

github-actions bot commented Mar 7, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 58 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 409 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 45 out of 45 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 45 out of 45 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link

github-actions bot commented Mar 7, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 58 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 409 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

@christopherwharrop-noaa christopherwharrop-noaa merged commit cca45b0 into main Mar 7, 2026
12 checks passed
@christopherwharrop-noaa christopherwharrop-noaa deleted the feature/update-docs branch March 7, 2026 16:19
@github-actions
Copy link

github-actions bot commented Mar 7, 2026

📊 Test Coverage Report

Status:PASS (Coverage: 100.00% | Threshold: 100%)

Name Stmts Miss Cover Missing
src/chiltepin/__init__.py 0 0 100.00%
src/chiltepin/cli.py 38 0 100.00%
src/chiltepin/configure.py 59 0 100.00%
src/chiltepin/data.py 58 0 100.00%
src/chiltepin/endpoint.py 215 0 100.00%
src/chiltepin/tasks.py 39 0 100.00%
TOTAL 409 0 100.00%

Coverage report generated by pytest-cov. Full HTML report available in workflow artifacts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Transition to readthedocs

2 participants